gh-85747: "Preface" section of asyncio-eventloop.rst: Switch to active voice and suggest other edits #99784
Conversation
"Preface" section of asyncio-eventloop.rst. As per python#85747.
bskinn
requested review from
1st1,
asvetlov,
gvanrossum and
kumaraditya303
as code owners
Doc/library/asyncio-eventloop.rst
Outdated
| Emits a deprecation warning if there is no running event loop. | ||
| In future Python releases, this function will become an alias of | ||
| :func:`get_running_loop` and will accordingly raise a | ||
| :exc:`RuntimeError` if there is no running event loop. |
There was a problem hiding this comment.
Unfortunately, while for a long time that was indeed the plan, we are considering undeprecating it, based on feedback received from users who rely on this (see #93453). Maybe all we need to do, while this is as yet undecided, is to say "may" instead of "will"?
There was a problem hiding this comment.
Yep, reading the discussion, I think a switch to "may" would suffice.
Would it be good/useful also to link to that ongoing discussion, from this point in the docs? Or is the philosophy of the docs to avoid that kind of contemporaneity?
There was a problem hiding this comment.
I would skip the link, it will just confuse folks. We'll update these docs once we are sure.
Hopefully this PR can be backported to 3.11 and maybe 3.10.
|
A Python core developer has requested some changes be made to your pull request before we can consider merging it. If you could please address their requests along with any other requests in other reviews from core developers that would be appreciated. Once you have made the requested changes, please leave a comment on this pull request containing the phrase And if you don't make the requested changes, you will be put in the comfy chair! |
gvanrossum
added
needs backport to 3.10
|
I have made the requested changes; please review again |
|
Thanks for making the requested changes! @gvanrossum: please review the changes made to this pull request. |
|
Thanks @bskinn for the PR, and @gvanrossum for merging it 🌮🎉.. I'm working now to backport this PR to: 3.10, 3.11. |
|
GH-99980 is a backport of this pull request to the 3.11 branch. |
… active voice and suggest other edits (pythonGH-99784) (cherry picked from commit bf26bdf) Co-authored-by: Brian Skinn <brian.skinn@gmail.com>
|
GH-99981 is a backport of this pull request to the 3.10 branch. |
… active voice and suggest other edits (pythonGH-99784) (cherry picked from commit bf26bdf) Co-authored-by: Brian Skinn <brian.skinn@gmail.com>
As per discussion in #85747, a very small PR focused just on the "Preface" section of asyncio-eventloop.rst.
In addition to a couple of switches from passive to active voice, I've also suggested a few other edits that, to me, improve clarity. Please advise if proposed edits of this sort are welcome as a part of this effort of #85747, or if PRs should stick ~strictly to passive->active voice edits.